<html>
<head>
<title>Contributing to FindBugs</title>
<link rel="stylesheet" type="text/css" href="findbugs.css">
@GOOGLE_ANALYTICS@
</head>
<body>

<table width="100%"><tr>

@HTML_SIDEBAR@

<td align="left" valign="top">

<h1>Contributing to FindBugs</h1>

<p> If you have a bug fix or feature enhancement you would like to contribute,
we would be happy to consider it for inclusion.</p>

<h2>Import FindBugs code as Eclipse projects</h2>

<p>The preferred way to get the FindBugs source code and create the patch is to use Eclipse + SVN.
You can easily import FindBugs code into Eclipse by following the steps described
here: <a href="http://code.google.com/p/findbugs/source/browse/trunk/eclipsePlugin/doc/building_findbugsplugin.txt">Import Eclipse projects</a>
. 
</p>

<h2>Preparing a patch</h2>

<p> The best way to
send an enhancement is to create a patch against the latest code
in the FindBugs Subversion repository 
at <a href="http://findbugs.googlecode.com/svn/trunk/">http://findbugs.googlecode.com/svn/trunk/</a>
(those people who have been given commit priviledges should use 
<a href="https://findbugs.googlecode.com/svn/trunk/">http<b>s</b>://findbugs.googlecode.com/svn/trunk/</a>).
</p>

<p>To create a patch from Eclipse, please right click the [findbugs] or [findBugsEclipsePlugin] project
and choose [Team | Create Patch...] context menu.
</p>

<p> Please follow these guidelines when preparing your patch:</p>
<ul>
<li> <b>Use the same indentation style as the source file(s) you
     are modifying</b>.&nbsp; In particular, please use tabs (not spaces)
     to indent your code; one tab per indent level.
<li> If at all possible, avoid making whitespace modifications.
<li> Small patches are appreciated.
<li> If you are submitting a new bug detector, please submit a small
     standalone source file that contains an instance of the
     kind of bug the detector looks for.
</ul>

<p> Following these guidelines makes it much easier for us
to incorporate new code.

<h2>How to submit a patch</h2>

<p> Patches may be submitted through the
<a href="http://sourceforge.net/tracker/?atid=614695&group_id=96405&func=browse">Patches</a> tracker on the
<a href="http://sourceforge.net/projects/findbugs/">sourceforge project page</a>.

@HTML_FOOTER@

</td>

</tr></table>

</body>
</html>
